<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenIG: OpenIG::Base::FileSystem Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="openig_logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">OpenIG
   &#160;<span id="projectnumber">2.0.7</span>
   </div>
   <div id="projectbrief">cross-platform open-source OpenSceneGraph Image Generator</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>OpenIG</b></li><li class="navelem"><b>Base</b></li><li class="navelem"><a class="el" href="class_open_i_g_1_1_base_1_1_file_system.html">FileSystem</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="class_open_i_g_1_1_base_1_1_file_system-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">OpenIG::Base::FileSystem Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="class_open_i_g_1_1_base_1_1_file_system.html" title="The FileSystem class. ">FileSystem</a> class.  
 <a href="class_open_i_g_1_1_base_1_1_file_system.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_file_system_8h_source.html">FileSystem.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a086a9d70656c2407794b08e4d5f60a39"><td class="memItemLeft" align="right" valign="top"><a id="a086a9d70656c2407794b08e4d5f60a39"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>PathType</b> { <br />
&#160;&#160;<b>None</b>, 
<b>Plugins</b>, 
<b>Data</b>, 
<b>Resources</b>, 
<br />
&#160;&#160;<b>PathList</b>
<br />
 }</td></tr>
<tr class="separator:a086a9d70656c2407794b08e4d5f60a39"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aad1a21087269a729a4332a99ef821781"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_i_g_1_1_base_1_1_file_system.html#aad1a21087269a729a4332a99ef821781">fileExists</a> (const std::string &amp;strFileName)</td></tr>
<tr class="memdesc:aad1a21087269a729a4332a99ef821781"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a given file exists.  <a href="#aad1a21087269a729a4332a99ef821781">More...</a><br /></td></tr>
<tr class="separator:aad1a21087269a729a4332a99ef821781"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefb732cc9f90409a85da562c0a474cf8"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_i_g_1_1_base_1_1_file_system.html#aefb732cc9f90409a85da562c0a474cf8">readFileIntoString</a> (const std::string &amp;strFileName)</td></tr>
<tr class="memdesc:aefb732cc9f90409a85da562c0a474cf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a whole file into a string.  <a href="#aefb732cc9f90409a85da562c0a474cf8">More...</a><br /></td></tr>
<tr class="separator:aefb732cc9f90409a85da562c0a474cf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad9e2c135ce4a6de540e95b0057a75bc"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_i_g_1_1_base_1_1_file_system.html#aad9e2c135ce4a6de540e95b0057a75bc">fileFullPath</a> (const std::string &amp;strFileName)</td></tr>
<tr class="memdesc:aad9e2c135ce4a6de540e95b0057a75bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the full path of a file.  <a href="#aad9e2c135ce4a6de540e95b0057a75bc">More...</a><br /></td></tr>
<tr class="separator:aad9e2c135ce4a6de540e95b0057a75bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34c4eecc60e9452f79ff917492e65bcd"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_i_g_1_1_base_1_1_file_system.html#a34c4eecc60e9452f79ff917492e65bcd">path</a> (PathType type, const std::string &amp;path=&quot;&quot;)</td></tr>
<tr class="memdesc:a34c4eecc60e9452f79ff917492e65bcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the full path of a given type based on the host system.  <a href="#a34c4eecc60e9452f79ff917492e65bcd">More...</a><br /></td></tr>
<tr class="separator:a34c4eecc60e9452f79ff917492e65bcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6c2952819014acd84d8d35eb8d68dcb"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_i_g_1_1_base_1_1_file_system.html#aa6c2952819014acd84d8d35eb8d68dcb">match</a> (const OpenIG::Base::StringUtils::StringList &amp;patterns, const std::string &amp;simpleFileName)</td></tr>
<tr class="memdesc:aa6c2952819014acd84d8d35eb8d68dcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the matched existing file from a given FileList. You can use wild cards.  <a href="#aa6c2952819014acd84d8d35eb8d68dcb">More...</a><br /></td></tr>
<tr class="separator:aa6c2952819014acd84d8d35eb8d68dcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77529fe64a556694d95f613f2e5d53ac"><td class="memItemLeft" align="right" valign="top">static time_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_i_g_1_1_base_1_1_file_system.html#a77529fe64a556694d95f613f2e5d53ac">lastWriteTime</a> (const std::string &amp;fileName)</td></tr>
<tr class="memdesc:a77529fe64a556694d95f613f2e5d53ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the time stamp of the last write.  <a href="#a77529fe64a556694d95f613f2e5d53ac">More...</a><br /></td></tr>
<tr class="separator:a77529fe64a556694d95f613f2e5d53ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="class_open_i_g_1_1_base_1_1_file_system.html" title="The FileSystem class. ">FileSystem</a> class. </p>
<p>Handy class to do few filesystem opertaions </p><dl class="section author"><dt>Author</dt><dd>Poojan Prabhu <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Thu Oct 22 2015 </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aad1a21087269a729a4332a99ef821781"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad1a21087269a729a4332a99ef821781">&#9670;&nbsp;</a></span>fileExists()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool OpenIG::Base::FileSystem::fileExists </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>strFileName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Checks if a given file exists. </p>
<p>Checks if a given file exists </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">strFileName</td><td>the name of the file </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if a file exists false otherwise </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Poojan Prabhu <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Thu Oct 22 2015 </dd></dl>

</div>
</div>
<a id="aad9e2c135ce4a6de540e95b0057a75bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad9e2c135ce4a6de540e95b0057a75bc">&#9670;&nbsp;</a></span>fileFullPath()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static std::string OpenIG::Base::FileSystem::fileFullPath </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>strFileName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the full path of a file. </p>
<p>Returns the full path of a file </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">strFileName</td><td>the name of the file </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the full path </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Poojan Prabhu <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Thu Oct 22 2015 </dd></dl>

</div>
</div>
<a id="a77529fe64a556694d95f613f2e5d53ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77529fe64a556694d95f613f2e5d53ac">&#9670;&nbsp;</a></span>lastWriteTime()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static time_t OpenIG::Base::FileSystem::lastWriteTime </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>fileName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the time stamp of the last write. </p>
<p>Returns the time stamp of the last write </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fileName</td><td>the file name to check </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the time stamp </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Trajce Nikolov Nick <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Thu Jan 14 2016 </dd></dl>

</div>
</div>
<a id="aa6c2952819014acd84d8d35eb8d68dcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6c2952819014acd84d8d35eb8d68dcb">&#9670;&nbsp;</a></span>match()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool OpenIG::Base::FileSystem::match </td>
          <td>(</td>
          <td class="paramtype">const OpenIG::Base::StringUtils::StringList &amp;&#160;</td>
          <td class="paramname"><em>patterns</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>simpleFileName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the matched existing file from a given FileList. You can use wild cards. </p>
<p>Returns the matched existing file from a given FileList. You can use wild cards and regex </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">patterns</td><td>StringList containing file names with path. You can use wildcard </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the full path of the file found </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Trajce Nikolov Nick <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Sat Oct 31 2015 </dd></dl>

</div>
</div>
<a id="a34c4eecc60e9452f79ff917492e65bcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34c4eecc60e9452f79ff917492e65bcd">&#9670;&nbsp;</a></span>path()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static std::string OpenIG::Base::FileSystem::path </td>
          <td>(</td>
          <td class="paramtype">PathType&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>path</em> = <code>&quot;&quot;</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the full path of a given type based on the host system. </p>
<p>Returns the full path of a given type based on the host system </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">type</td><td>the enum above </td></tr>
    <tr><td class="paramname">path</td><td>optional additional path to be appended </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the full path based on ENV vars and host system, differs for Linux, Windows and Mac </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Trajce Nikolov Nick <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Thu Oct 22 2015 </dd></dl>

</div>
</div>
<a id="aefb732cc9f90409a85da562c0a474cf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefb732cc9f90409a85da562c0a474cf8">&#9670;&nbsp;</a></span>readFileIntoString()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static std::string OpenIG::Base::FileSystem::readFileIntoString </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>strFileName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads a whole file into a string. </p>
<p>Reads a whole file into a string </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">strFileName</td><td>the name of the file </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the file as a string </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Poojan Prabhu <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Thu Oct 22 2015 </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Core-Base/<a class="el" href="_file_system_8h_source.html">FileSystem.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 16 2018 15:41:11 for OpenIG by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
